SuperHack/SuperHack CD.bin/SCRIPTZ/PMR40.EXE/README.TXT

Text File | 1997-03-22 | 32KB | 566 lines

Welcome to the readme.txt file for the Protection MASTER Script version 4.
This script is copyright (c) 1997 Ventura.


--= Intro =--

SPECIAL NOTE: If this is the second time you have downloaded version 4.0 of
this script, sorry about the installation problems that you may have
experienced the first time around. I was forgetting that not everybody is as
proficient with the dos prompt as I am. This time round, the winzip self-
extracting exe file should have made life a lot easier.

If you have a problem with the script, or have found what you think is a
bug, and the answer isn't in this file, come to #Protection on DALnet.  It's
the official help channel for the Protection MASTER Script, and I have set it
up for this purpose.  Here, I'll be happy to answer your questions (assuming
the answers aren't already here, of course). I should mention; with regards to
3.25final, I had a couple of annoying visitors over the weeks, so if you're
not coming to have a decent, civilised conversation with me, then don't bother
atall. Alternatively, if I'm not on the channel, you can always email me, on
[e-mail]. Above all, have fun on irc, because that's what it's
there for :)

I'll be accepting submissions from people with regards to version 4.1, so if
there's anything you'd like to see in this script, get in touch with me, via
one of the two ways mentioned above. I don't make any promises about whether
or not this will happen tho; your submission may not see the light of day,
but it helps if it's logical, clear, and at least 'protection-related'...


--= How good are you? =--

I will assume that you've set the script up, and have entered your
appropriate settings into mIRC.  If you're relatively new to irc, and don't
know what a lot of the stuff in this script will mean, I suggest you use
the simple version of the popups, rather than the advanced. In the status
window popup, you can see "==> SwitchToSimplePopups <=="...i would assume
you click that immediately. The popups that you will then be using should
appear a lot simpler, with fewer options. Despite there being a simple popups
menu tho, this script is geared more towards the professional ircer.  With
the level of customisability available, and the sheer number of options,
you're going to have to know what these things mean.


--= Keyboard Shortcuts =--

There are currently 6 keyboard shortcuts programmed into the script.  The
first 5 (F5-F9) are used to view the current settings; F10 is an emergency
shortcut that will enable all private flood protection on very high settings,
turn immunity off and enable the kick on private flood...

        F5 - View the Channel Flood Protection settings
        F6 - View the Channel Mass Mode Protection settings
        F7 - View the Private Flood Protection settings
        F8 - View the Private CTCP Protection settings
        F9 - View the Miscellaneous settings
        F10 - Emergency enable all private flood protection, disable immunity,
              and enable the private flood kick

If you have used F10, you will have to re-enter all of your prior settings
into the script (admittedly there aren't many tho). I'm considering making
this a taggable button, to switch between the emergency settings and your
normal settings; it all comes down to coding space.  Check out the changes I
will have listed when I release 4.1, to see if this happened...


--= The Popups =--

Due to size limitations, the popups format has been changed slightly from
the last version, 3.25.  The popup that will appear in the status window and
the toolbar popup contains the input to change the flood protection
settings. The popups that appear in the channel popups contain channel-
specific functions only, like performing channel scans, and adding and
removing from the auto join list.


**STATUS WINDOW AND TOOLBAR POPUPS**

CHANNEL FLOOD PROTECTION SETTINGS
(concerning the various types of flood that people can perform in a channel.
The Viewing current settings, at the top, displays all the current settings
for your perusal).

-Channel Text Flood - this controls normal text flood, and includes action
        /me commands, and channel-wide notices. You can disable the routine,
        so that the script doesn't check for text flood within the channel,
        enable the routine (based on the current settings), and edit the
        settings. The script will ask "how many lines of text (default 5)"
        to which, you key in a number indicating how many lines must pass
        before you wish to have the flood protection initiate, and then click
        on 'ok', or press enter. Then it will ask "In how many seconds
        (default 5)" In here you input in how many seconds that these lines
        must occur, for the text flood protection to initiate. Once these
        two settings have been correctly entered, the script will inform
        you that "channel text flood protection now activates on <??> lines
        in <??> seconds when enabled", depending on the choices you made.
        The more extreme settings have been cancelled out, so it is impossible
        to enter unreasonable amounts.

-Channel Join-Part Flood - Some people like to flood a channel by joining the
        channel, then parting, then joining, then parting....over and over.
        If its done quickly enough, it can be an annoying flood, so there
        must be protection for it. As it was with the channel text flood,
        you may edit the settings to choose how many times that this must
        happen (either a join or a part), in how many seconds, before the
        script's protection engages to combat such a flood.

-Channel Nick-Change Flood - Another known way of flooding is by changing
        your nickname continuously. This can also be frustrating to prevent
        since the nick is always changing, and it can be hard to establish a
        lock in order to invoke the protection.

-Channel Repeating Flood - Exactly what it says...people saying the same
        thing two or three, or even more times.  It's unnecessary, and can
        be easily prevented. Most people think that protection on just two
        repeats is a bit unnecessary, so the default is set at 3. The old
        script had repeat protection, but it was set to protect on two
        repeats, and this could not be modified.

-Channel Length Flood - this comes into an effect when a line from someone
        is unncessarily long, usually enough to fill up a couple of lines. On
        some systems, with a smaller windows resolution and larger font size,
        a length flood can effectively equate to 3 lines of normal text,
        perhaps more. The setting to be changed for this, isn't "how many
        times in how many seconds", but "how long".  It counts the number
        of characters submitted, with the default of 300 being very fair.

-Channel Colour Flood - I don't have anything against colour myself, but too
        much of it is definitely annoying, so there has to be a kick that
        protects against it. The command used for colour change in text is
        ctrl+k, which the script searches for.  It detects how many times
        ctrl+k has been used, and then kicks if it exceeds the current
        setting. The setting for this defines the colour change limit.

-Channel CAPS Flood - Excessive CAPS use can be just as annoying as many of
        the other types of flood.  This protection covers not only caps,
        but excessive use of strange characters too, such as %*$*((*$.  The
        setting for this determines the minimum length of any submission,
        before the caps protection is considered (eg. someone saying :) -
        while that is classed as 'strange characters', you wouldnt want to
        kick someone for it.

CHANNEL MASS MODE PROTECTION SETTINGS
(These settings are more channel protection related, rather than flood
protection. An attempted mass-deop (the sign of a takeover), for example, can
be prevented by protecting if too many deops happen too quickly).

-Mass Deop Protection - How many deops will you allow in how much time,
        before you think its time to do something about it?

-The rest of these, from this point, are pretty straightforward.  Mass Op
        protection initiates on too many ops, and you've got mass kick, ban
        and devoice protection also.

PRIVATE FLOOD PROTECTION SETTINGS
(These settings are not channel-related. Now we're talking various private
text protections, including dcc text).

-Private MSG Flood - If people direct flood attacks against you, this is
        the best way to prevent it.  As usual, you can select how many times
        in how many seconds, an msg must be received from another person,
        before you initiate ignore protection.

-Private Notice Flood - Normally, /notice's would be placed in the routine
        above, but I wanted to separate them.  Being on DALnet, I don't want
        to be ignoring ChanServ and NickServ, but I still want to be able to
        enable msg flood protection.

-The rest of these work the same way as the channel flood protection settings.
        There is also protection for dcc text flood protection. It might be a
        good time to mention that the repeating, length, colour and caps
        protections work for msg, notice and dcc text, so if you're going to
        turn repeating on for 3 repeats in 5 seconds, it will check for
        notice repeating and dcc text repeating, aswell as msg repeating.

PRIVATE CTCP PROTECTION SETTINGS
(This is the sort of stuff that has the ability to flood you off the server,
because it usually demands a reply from the receiver, and if you're caught
replying to too much, the server takes you out as part of its own flood
protection).

-Private CTCP Flood - This is the big one, right here, but the Protection
        MASTER has excellent CTCP flood protection. This covers pings and
        versions and userinfo's and all that, but nothing to do with dcc
        requests or sound requests (they have their own flood protection
        routines). As usual, you can specify how many you must receive in
        how many seconds, before the protection sets in, but this works a
        little differently in that, when this counts up, it counts everyone,
        not just individual people.  This is because several of the more
        powerful floods (I've encountered one from efnet) involve ctcp
        requests from a lot of different locations, which require an
        immediate ignore to combat. Thus, when invoking protection, this
        routine ignores EVERYONE. It ignores all further ctcp commands from
        ANYONE for 30 seconds. You don't ever have to worry about being ctcp
        flooded off of irc (I don't care what irc network you're on).

-Private DCC Send/Chat Flood - This works on the dcc sends and chat received.
        Some people like to dcc request flood because you end up with
        windows all about the place asking if you want to accept this file
        or that chat. Of course, you can choose how many you must receive
        before your protection engages.

-Private Sound Flood - I can't say I've ever been sound flooded, but someone
        out there will have, and this may come in handy.

-Invite Flood Protection - If you don't like being invited, now you can do
        something about it. The invite protection doesn't work like the
        others do - how many in how many seconds - instead the protection
        for this executes on the first invite received. You have the option
        to disable protection, ignore further invites for 30 seconds, or to
        kick (if possible) and also ignore.

MISCELLANEOUS SETTINGS
(Now we're getting down to business.  This is where I describe all the
settings that can be chosen to individually customise your protection
settings).

-Immunity - This setting is used for that special group of people that you
        dont want to impose the protection settings upon.  This is where
        the immunity comes in. You can make either your super ops, super and
        voiced users, or all channel ops, immune to your protection settings.
        This also means that, theoretically, they could flood the hell out of
        you, so it would be wise to edit this setting with care. If anyone
        comes to me saying "A superop of mine flooded me off"...well...you
        were warned.

-Channel Flooding Punishment Severity - Not long ago I learned that a user
        who was deopped and banned in a channel, couldn't speak. Like being
        in a moderated channel without a voice. So, for those of you who
        wish to just silence someone for that text flood, instead of something
        as forceful as a kick, you can just deop (if opped) and ban a user,
        without adding the kick. A neat option is the option to edit the
        timer length of the ban aswell...you can enter how many seconds you
        want the ban to last. This only works for text flood tho, and
        things like nick change flood, are obviously not affected by it, so
        if someone nick change floods the channel, they will be kicked
        regardless of this setting.

-Kicking on Private Flood - If you don't like being privately flooded, and
        want to make sure everyone knows about it, you can turn this feature
        on. If someone floods you in a channel you have ops on, with this
        setting, you will attempt to kick that person from each channel you
        can (all you need is ops). Its a great feature to engage, but if
        you're accidentally flooded by a friend who's not covered in the
        immunity setting (above), it may just make a bad thing worse...

-Clone On-Join Detection - The best way to get clones is when they join the
        channel, and this baby will do just that. If you're not interested
        in how many clones are around, you can disable the feature. If you
        want to be informed about clone entry, but that's it...you can do
        that too. But you can also take an active step towards preventing
        how many clones are allowed. You can set a limit...say 2...and the
        script will allow no more than two clones into the channel. If a
        third joins...BAM...they get kick/banned. You can set this limit
        anywhere from 1 to around 20 (enough to cover all circumstances), so
        you'll never have to worry about them again.

-Mode Change Protection - The Protection MASTER version 3.25final has a mode
        change protection feature that went on +tn -everything else.  But
        what if your channel defaults to +s for secret, or if you have
        a key set to deny unwanted access to the channel. Well, welcome to
        version 4. You can set a default mode setting that will be enforced
        by the script regardless (except in immunity conditions). A view of
        the options surrounding the setting detail a number of ways that
        it can be enabled. 'Normal' just resets the channel modes...'Deop'
        adds in a deop to whoever attempted the mode change, and 'kick/ban'
        sends them flying out of the channel for it. Editing the settings
        will ask you for the plus modes. The default is +tn, but you only
        have to enter tn. If you entry contains +k or +l (key or limit),
        the next box to appear will ask you for the keysetting or the limit
        number (or both). Then you enter your minus modes. From this point,
        the script will attempt to enforce the new mode settings in all
        channels, so before you edit these settings, it would best to make
        sure you have the authority to do so. The script also sets these
        modes when you've just been opped in a channel, and also when you
        use the channel popups to change the topic to one of those stored...

-Server Op Protection - One of the easiest way to gain control of a channel
        is to ride a split server with a few pals. When the split reconnects,
        you end up with ops in the main channel, since the split server would
        have been empty initially. So server op protection deops everything
        that gets ops through a server op, as long as it aint a super op on
        the script.  Beware tho, whatever you're rejoining will probably have
        server op protection of its own, so all-out war usually follows.

Super Op auto opping - I added this in as it was requested, but it wasn't
        something I planned. If, for some reason, you don't want your super
        ops to automatically get opped, you can just disable this routine.
        It also disables the auto-opping of any superops in the channel when
        the script gets opped.

Revenge setting - People love this, but it can set off a nasty loop. If
        you're kicked from a channel, and you have this on, and whoever kicked
        you wasn't a superop, you will kick that person back as soon as you
        get the chance. If you're deopped, and you get ops back, you're gonna
        try to deop that person back.

Offensive nick protection - Do you hate those guys who join yer channel, and
        they gotta have an obscene nick like "YaFaggot"?? Well, now's yer
        chance to get em on impact. The nick protection makes good use of a
        nick list that is fully customisable.  You can add words to the list,
        and every time someone comes into the channel, if any word on your
        nick list is part of their nick, they get booted.

Unallowed text Protection - The storage for the words protection works in
        much the same way as the nick protection, above, but now we're
        talking about channel text.  You can easily customise a list of
        words, even phrases, that are not allowed, and if it appears in
        someone's text, they're gone. As with the 'Channel flooding
        punishment severity', you can choose to enable this in such a
        way that the user is just banned, so as to just enforce silence,
        without kicking.

IRCop join notification - if you want to know about an ircop joining any
        channel you're opped on, just enable this routine.  It echoes a nice,
        harmless, private message in your active window whenever an ircop
        joins a channel.

Super ops can only op - If you have a strict policy on who's allowed to give
        out ops in your channel, this is the routine for you.  When enabled,
        it will auto-deop ANY op made where the opper wasn't a super op.
        Effectively, only super ops (plus yourself, of course) will be able
        to give out that @.

Channel auto join - If there's a favourite few channels that you have on your
        irc network of choice, that you'd just LOVE to auto-join when mIRC
        start up, this is what you want. This popup merely provides the way
        to turn this routine on or off; adding and removing channels from
        the list involves use of the channel window popup, but its very easy
        to do.

Auto Pinger - Some people like this option, other's dont.  When enabled, when
        someone types 'ping me' in a channel you're opped on, they are
        automatically pinged, and then noticed of the result. When disabled,
        this does not happen.

Viewing current statistics - Throughout each main popup area, at the top, has
        been a link where you can view the current settings. These default
        to being displayed in an independent window, titled
        "Current-Settings", but if you'd prefer that they go to the status
        window, you can edit that selection here.


**CHANNEL WINDOW POPUPS**

CHANNEL SCANS
(This is the place to go if you want to view some current statistics relating
to the current active channel).

Statistics Scan - This will scan the channel and return such information as
        how many ops are on the channel, how many are away, and also how many
        clones and ircops are currently in the channel. The options with this
        include "private echo', to private display the information to
        yourself (ie. the channel doesn't see it) and 'public MSG', where the
        channel is messaged of the results of the scan.

Clone Scan - This works in much the same way as the statistics scan above,
        but is dedicated for clones display. Clones are listed line by line
        with the nicks of any particular address displayed alongside.

IRCop Scan - This works must like the top two; it does a channel scan, this
        time for any IRCops, and displays them line by line...

CHANNEL TOPIC LOCK
(If you want to restrict people access to change the channel's topic, and
even to impose a punishment for that attempt, these options make that
possible with a wide range of customisability).

The popups within this area suitably explain the options available. A varying
degree of customisability exists, with options ranging from super ops being
immune to the lock (ie. they CAN still change the topic) through to varying
degrees of punishment if a topic change is attempted.

CHANNEL VOTE
(If you want to conduct a channel vote based upon a certain theme, with -
preferably - a yes or no answer - this will do it. The vote does not 'turn
off' after a certain time, so you have to turn it off within a suitable
amount of time).

A topic needs to be entered when you enable the vote...then it starts.  The
active channel is messaged with the vote being active, the topic, and how
they can vote either yes or no. This is all very simple.  Every 60 seconds,
until the vote is turned off, a message is replayed to the channel quickly
summarising the topic and how to vote if anyone has not already done so.

The script prevents anyone being able to vote more than once, and even voting
flood protection if people get carried away with their submissions. This
activates on three attempts to vote in 5 seconds. Voting submission are
made private to the script user, so the result will be a surprise to everyone.

AUTO JOIN LIST
(If you have one, or a number, of channels, that you would to auto-join after
startup, this is the area).

Here you can add or remove channels to the auto-join list. The option for
actually turning on or off auto-joining can be found in the miscellaneous
options area for the status window or toolbar popups.

AWAY/BACK OPTIONS
(This covers those times when you are not by the computer. A number of options
are in place now, to make your away/back time more comfortable).

Set Away - This will set you as away. You will be asked to enter an away
        message; the script will do the rest.

Set Back - This will return you to a 'not-away' status. If you have been
        paged and/or messaged since you set away, a quick message will pop
        up informing you of this, so that you may wish to take steps towards
        viewing the file that houses these messages.

Change Away Message - This can only be used WHILE you are away.  If you find
        you've been away for a while, and would like to inform the channel
        of your current away situation, without having to manually return
        and then set away again, with this you can quickly and easily, change
        your away reason.

Edit Away Message Timer Length - The away timer broadcasts into the channel
        every 10 minutes, on default, but you can set that from 1 minute to
        60 minutes. This option can be enabled while you are away also, with
        the timers for the message immediately adjusting.

Page/Message File - If you are away and people page you, or message you,
        the responses are stored here, in a convenient format, for your
        perusal. The script auto-runs notepad in order to view this file,
        so if for some reason, you dont have this, you will have to use
        a text file viewer to directly view the messages.txt file located in
        the \settings directory off your mirc home directory. An easy popup
        is provided to also clear the contents of this file.

Recording Options - This covers the means by which people can contact you
        while you are away. At your disposal, you have a Pager and an
        MSGLogger. Both record the nickname, time received, and format, of
        the message that was received (if so).

        To page you, people type /ctcp <yournick> page <optional
        message> - This plays a sound file distributed with this script that
        *might* grab your attention.  This is the best way to do so if they
        are away, yet within 'hearing' distance of the computer.

        To message you, like a normal message, people type /msg <yournick>
        <message> - This just stores the message, but does not play a sound
        or anything like that. When away, any message windows that are
        opened are automatically closed, so as not to clutter up the display
        when you return...

Auto Idle Away Options - Sometimes, you might find yourself busy doing
        something that won't give you the chance to set yourself as away
        properly (or you may just have forgotten to do so). The idle-away
        checks any inactivity with the computer for a certain amount of
        time, and automatically sets you as away if that limit is met. This
        only seems to reset on direct input from the keyboard, so, despite
        whatever else you might be doing, if you are not talking with anyone
        on irc, your idle timer will be steadily increasing.

        The option is included here to disable or enable the auto-away
        option, and to change the length of time that must pass before you
        auto-idle-away. As with the normal away timer length, this accepts
        an input in minutes; anywhere from 1 minute to 60 minutes. The default
        is 10 minutes.

Topic Changes - Here there are just a couple of popups that will change the
current channel's topic.  This doesn't really serve much purpose, but if you
join an empty channel and wish to set a topic, click on one of these.  This
routine also runs the enforce mode routine, that will enforce any current
mode settings. It's a nice and easy way to set up a channel that's empty when
you join it...

DALnet - Most of the popups here should be reasonably straightforward with
people who irc on DALnet most of the time, and use ChanServ and NickServ
often to enter commands. On an initial startup of the script, a chanserv pass
and a nickserv pass will need to be created, which the script will immediately
prompt you to do on the first use of a popup that will use this password (ie.
using ChanServ to identify with the current channel's founder password). This
only stores one type of password, so if you're on DALnet with more than one
channel registered to you, you will want to make the password the same for
both channels.


** CHANNEL NICKNAMES LIST POPUPS **

User Stuff - Welcome to user central. This is the area where you tell the
        script who you like, who you don't, and how you want the script to
        treat these people.

        You will notice that you can add users via Dynamic or Static IP. If
        this doesn't make much sense to you, then it would be advisable to
        just add as a Dynamic IP, since this is what most people have. In
        short, someone with a dynamic address has an IP that is always
        changing (every time they log onto the internet) and a static
        address is one that never changes. As said, most people will have a
        Dynamic IP...

        Super Ops - These guys are the creme de la creme! They are the
        most important guys on your channel. By default, they are opped on
        entry into ANY channel you are on, and the script will actively
        protect these people to its full capability. Things like the revenge
        setting, automatically DO NOT come into play when dealing with a
        superop. In short, choose these guys carefully...

        Voiced Users - These guys get an automatic +v on entry into the
        channel, and their voice setting is protected if anyone but a super
        op attempted to devoice them. As an added option, immunity can be
        enabled for these guys aswell as the super ops, in one instance..

        Denied Ops - denied ops are simply denied ops on ANY channel that
        you have operations on. It will not deop if the opper isn't on the
        channel (ie. it's from something more powerful, like ChanServ),
        because when ChanServ usually ops something, it's gonna fight to
        keep that op setting (thus creating a deop/op channel flood).

        Shitlist - These guys, you do NOT want around. On adding someone to
        the shitlist, that person, and all associated clones, are removed
        from all channels that you can do this.

The rest of the popups in this group are fairly simple. Options are there
to op, deop, voice or devoice users, aswell as a variety of ways to kick
and/or ban, and ignore.  There is also an easy page facility made available
to page people with the standard '/ctcp <nickname> page <message>'. Below
these are a couple of DALnet-only popups, which will make sense to those who
spend their time there.


--= Other Things I can think of =--

I had a complaint with 3.25 that someone's friend was being opped by the
script.  It turns out that they had the same ISP and the same mIRC UserId
(they had to, apparently).  I also know people who have the same IP (with the
same ISP) but can have different UserId's.  Anyway, with version 4, the
script will only treat a clone of yours AS a clone of yours when it has the
same IP AND UserId, so if you load up a clone that has a different UserId,
it's not going to recognise it.  The solution is simple then; just add that
clone to the super ops list. Of course, when doing things like a clone list,
it will show up as your clone if it has the same IP, but that's just the
way these things work :)

If you spend your time on DALnet, and you are ever kicked from a channel, you
might notice ChanServ working very hard to get you back in there.  A number
of DALnet-only commands have been added to the script, at times like having
been kicked and deopped, where the script will tell ChanServ to unban you and
deop the person who deopped or kicked you, that sort of thing. You'll find,
if you're an AOP or better on a DALnet channel, and you are kicked, as long
as the services aren't lagging, you'll be back into that channel without
having to do a thing, banned or otherwise...


--= Thanks to... =--

Thanks go to my girlfriend, for being proud of me with regards to my
achievements as a mIRC Scripter on the internet. Also thanks to DaWabbit for
his beta testing skills, support and enthusiasm, and to many others who have
provided encouragement during the production of this version.


--= Disclaimer and Copyright =--

I am not responsible for what might happen as a result of your use of this
script. Your computer might explode, you might get klined or glined from
every major irc network on the planet...I don't care. I don't get paid
a cent from doing this, so I consider the release of this script to be pure
generosity on my part, and as such, there are absolutely NO guarantees
involved whatsoever.

This script is copyright (c) 1997 Ventura. If you copy it, you're a waste
of space. It doesn't take half a brain to write this stuff yourself; just
gotta have a lot of time, enthusiasm, and patience :)